Analysis: Containers

Analysis: Containers

#340560

Description

The /analysis/containers resource is used to return a list of all optimized container-based analysis entities currently in your Densify system. A container analysis entity encompasses container resources within a predefined environment scope. Typically, the scope of a container analysis entity corresponds to the container resources within a cluster discovered through Densify data collection.

See Container Prerequisites for container data collection details.

Resource

/analysis/containers

Supported Operations

Table: Container Analysis Supported Operations

Operation

HTTP Method

Input

Output

Description

List all container analyses in Densify

GET /analysis/containers

 

Collection of:

Use this resource to return a list of existing container analyses.

Example: Listing All Container Analyses

Response

Table: Container Analysis Response Schema

Element

Type

Filter/Sort

Description

analysisId

string

 

The unique identifier for the container analysis entity in Densify.

analysisName

string

Filter by:

  • analysisName
  • analysisName_like

The name given to the container analysis entity.

The analysis name typically corresponds to the cluster name from the container data collected.

analysisCompletedOn

string

 

The date and time (in milliseconds) when the last analysis completed.

If an analysis has never been completed, "0" is returned.

href

string

 

The referenced resource to the analysis entity.

See Analysis: Entity for details of the analysis entity resource.

analysisResults

string

 

The referenced resource to the recommendations of the analysis.

See Analysis: Kubernetes Container Recommendations for details on container recommendations.

analysisStatus

string

 

The referenced resource to the status of the analysis.

See Analysis: Status for details.

message

string

 

For errors, the message for the status response is returned.

status

number

 

The HTTP response code of the request error. Possible status values include:

  • 200—success with request;
  • 400—invalid parameters;
  • 401—authentication failed;
  • 404—resource not found;
  • 500—internal server error.

Examples

Example: Listing All Container Analyses

The following example shows you how to list all container analyses in Densify.

Request:

Copy 
GET /analysis/containers

Response:

Copy 
[
   {
      "analysisId": "3d4ba999-cbd8-40b8-9998-574be6824a97",
      "analysisName": "DEN-east-321-45b",
      "analysisCompletedOn": 1510180908845,
      "href": "/analysis/containers/kubernetes/3d4ba999-cbd8-40b8-9998-574be6824a97",
      "analysisResults": "/analysis/containers/kubernetes/3d4ba999-cbd8-40b8-9998-574be6824a97/results",
      "analysisStatus": "/analysis/containers/kubernetes/3d4ba999-cbd8-40b8-9998-574be6824a97/status"
   },
   {
      "analysisId": "97cfcb18-37a4-4f49-885b-8974eb2ceb31",
      "analysisName": "DEN-east-432-2",
      "analysisCompletedOn": 1543346324266,
      "href": "/analysis/containers/kubernetes/97cfcb18-37a4-4f49-885b-8974eb2ceb31",
      "analysisResults": "/analysis/containers/kubernetes/97cfcb18-37a4-4f49-885b-8974eb2ceb31/results",
      "analysisStatus": "/analysis/containers/kubernetes/97cfcb18-37a4-4f49-885b-8974eb2ceb31/status"
   }
]